<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><title>Index - Bonfire</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="IndexPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.5 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Index><div class=IPageTitle>Index</div><div class=INavigationBar><a href="General.html#Symbols">$#!</a> &middot; 0-9 &middot; <a href="General.html#A">A</a> &middot; <a href="General.html#B">B</a> &middot; <a href="General2.html#C">C</a> &middot; <a href="General3.html#D">D</a> &middot; <a href="General3.html#E">E</a> &middot; <a href="General3.html#F">F</a> &middot; <a href="General4.html#G">G</a> &middot; <a href="General4.html#H">H</a> &middot; <a href="General4.html#I">I</a> &middot; <a href="General4.html#J">J</a> &middot; <a href="General4.html#K">K</a> &middot; <a href="General4.html#L">L</a> &middot; <a href="#M">M</a> &middot; <a href="#N">N</a> &middot; <a href="#O">O</a> &middot; <a href="#P">P</a> &middot; <a href="#Q">Q</a> &middot; <a href="#R">R</a> &middot; <a href="General6.html#S">S</a> &middot; <a href="General6.html#T">T</a> &middot; <a href="General7.html#U">U</a> &middot; <a href="General7.html#V">V</a> &middot; <a href="General7.html#W">W</a> &middot; X &middot; <a href="General7.html#Y">Y</a> &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="M"></a>M</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/module_overview-txt.html#Mastering_Modules"  class=ISymbol>Mastering Modules</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/roles/controllers/settings-php.html#matrix_update" id=link256 onMouseOver="ShowTip(event, 'tt244', 'link256')" onMouseOut="HideTip('tt244')" class=ISymbol>matrix_update</a></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core_modules/subnav/controllers/subnav-php.html#$menu" id=link257 onMouseOver="ShowTip(event, 'tt245', 'link257')" onMouseOut="HideTip('tt245')" class=ISymbol>menu</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.message" id=link258 onMouseOver="ShowTip(event, 'tt246', 'link258')" onMouseOut="HideTip('tt246')" class=ISymbol>message</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.$message" id=link259 onMouseOver="ShowTip(event, 'tt247', 'link259')" onMouseOut="HideTip('tt247')" class=ISymbol>message</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migration_Interface" id=link260 onMouseOver="ShowTip(event, 'tt248', 'link260')" onMouseOut="HideTip('tt248')" class=ISymbol>Migration Interface</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/migrations-txt.html#Migration_Spheres" id=link261 onMouseOver="ShowTip(event, 'tt249', 'link261')" onMouseOut="HideTip('tt249')" class=ISymbol>Migration Spheres</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/migrations-txt.html#Migration_Types" id=link262 onMouseOver="ShowTip(event, 'tt250', 'link262')" onMouseOut="HideTip('tt250')" class=ISymbol>Migration Types</a></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migration_Interface.$migration_type" id=link263 onMouseOver="ShowTip(event, 'tt251', 'link263')" onMouseOut="HideTip('tt251')" class=ISymbol>migration_type</a>, <span class=IParent>Migration Interface</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>Migrations</span><div class=ISubIndex><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migrations" id=link264 onMouseOver="ShowTip(event, 'tt252', 'link264')" onMouseOut="HideTip('tt252')" class=IFile>core_modules/<wbr>migrations/<wbr>libraries/<wbr>Migrations.php</a><a href="../files2/core_modules/migrations-txt.html#Migrations" id=link265 onMouseOver="ShowTip(event, 'tt252', 'link265')" onMouseOut="HideTip('tt252')" class=IFile>core_modules/<wbr>migrations.txt</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migrations_Class" id=link266 onMouseOver="ShowTip(event, 'tt253', 'link266')" onMouseOut="HideTip('tt253')" class=ISymbol>Migrations Class</a></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.$modified_field" id=link267 onMouseOver="ShowTip(event, 'tt254', 'link267')" onMouseOut="HideTip('tt254')" class=ISymbol>modified_field</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/module_overview-txt.html#Module_Config_Files" id=link268 onMouseOver="ShowTip(event, 'tt255', 'link268')" onMouseOut="HideTip('tt255')" class=ISymbol>Module Config Files</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/application_helper-php.html#module_config" id=link269 onMouseOver="ShowTip(event, 'tt256', 'link269')" onMouseOut="HideTip('tt256')" class=ISymbol>module_config</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/application_helper-php.html#module_controller_exists" id=link270 onMouseOver="ShowTip(event, 'tt257', 'link270')" onMouseOut="HideTip('tt257')" class=ISymbol>module_controller_exists</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/application_helper-php.html#module_file_path" id=link271 onMouseOver="ShowTip(event, 'tt258', 'link271')" onMouseOut="HideTip('tt258')" class=ISymbol>module_file_path</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/application_helper-php.html#module_files" id=link272 onMouseOver="ShowTip(event, 'tt259', 'link272')" onMouseOut="HideTip('tt259')" class=ISymbol>module_files</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/application_helper-php.html#module_folders();" id=link273 onMouseOver="ShowTip(event, 'tt260', 'link273')" onMouseOut="HideTip('tt260')" class=ISymbol>module_folders();</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/assets-php.html#Assets_Class.module_js" id=link274 onMouseOver="ShowTip(event, 'tt261', 'link274')" onMouseOut="HideTip('tt261')" class=ISymbol>module_js</a>, <span class=IParent>Assets Class</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/application_helper-php.html#module_list" id=link275 onMouseOver="ShowTip(event, 'tt262', 'link275')" onMouseOut="HideTip('tt262')" class=ISymbol>module_list</a></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/libraries/assets-php.html#Assets_Class.$module_scripts" id=link276 onMouseOver="ShowTip(event, 'tt263', 'link276')" onMouseOut="HideTip('tt263')" class=ISymbol>module_scripts</a>, <span class=IParent>Assets Class</span></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/libraries/assets-php.html#Assets_Class.$module_styles" id=link277 onMouseOver="ShowTip(event, 'tt264', 'link277')" onMouseOut="HideTip('tt264')" class=ISymbol>module_styles</a>, <span class=IParent>Assets Class</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/introduction/concepts-txt.html#Modules" id=link278 onMouseOver="ShowTip(event, 'tt265', 'link278')" onMouseOut="HideTip('tt265')" class=ISymbol>Modules</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/module_overview-txt.html#Modules_Overview"  class=ISymbol>Modules Overview</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/application_folder-txt.html#Moving_the_Application_Folder" id=link279 onMouseOver="ShowTip(event, 'tt266', 'link279')" onMouseOut="HideTip('tt266')" class=ISymbol>Moving the Application Folder</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/MY_date_helper-php.html#MY_date_helper" id=link280 onMouseOver="ShowTip(event, 'tt267', 'link280')" onMouseOut="HideTip('tt267')" class=ISymbol>MY_date_helper</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#MY_Model" id=link281 onMouseOver="ShowTip(event, 'tt268', 'link281')" onMouseOut="HideTip('tt268')" class=ISymbol>MY_Model</a></td></tr><tr><td class=IHeading><a name="N"></a>N</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/permissions-txt.html#Naming_Permissions" id=link282 onMouseOver="ShowTip(event, 'tt269', 'link282')" onMouseOut="HideTip('tt269')" class=ISymbol>Naming Permissions</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.num_login_attempts" id=link283 onMouseOver="ShowTip(event, 'tt270', 'link283')" onMouseOut="HideTip('tt270')" class=ISymbol>num_login_attempts</a>, <span class=IParent>Auth</span></td></tr><tr><td class=IHeading><a name="O"></a>O</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/designers/introduction-txt.html#Just_Like_That.Only_Different" id=link284 onMouseOver="ShowTip(event, 'tt271', 'link284')" onMouseOut="HideTip('tt271')" class=ISymbol>Only Different</a>, <span class=IParent>Just Like That</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/installation/troubleshooting-txt.html#Only_the_Welcome_to_Bonfire_page_will_display" id=link285 onMouseOver="ShowTip(event, 'tt272', 'link285')" onMouseOut="HideTip('tt272')" class=ISymbol>Only the Welcome to Bonfire page will display</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/database-txt.html#Optimizing_Your_Database"  class=ISymbol>Optimizing Your Database</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.order_by" id=link286 onMouseOver="ShowTip(event, 'tt273', 'link286')" onMouseOut="HideTip('tt273')" class=ISymbol>order_by</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>$</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.$orig_view_path" id=link287 onMouseOver="ShowTip(event, 'tt274', 'link287')" onMouseOut="HideTip('tt274')" class=ISymbol>orig_view_path</a>, <span class=IParent>Template</span></td></tr><tr><td class=IHeading><a name="P"></a>P</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.parse_views" id=link288 onMouseOver="ShowTip(event, 'tt275', 'link288')" onMouseOut="HideTip('tt275')" class=ISymbol>parse_views</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.$parse_views" id=link289 onMouseOver="ShowTip(event, 'tt276', 'link289')" onMouseOut="HideTip('tt276')" class=ISymbol>parse_views</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/auth_notes-txt.html#Password_Security"  class=ISymbol>Password Security</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/database-txt.html#Performing_Backups" id=link290 onMouseOver="ShowTip(event, 'tt277', 'link290')" onMouseOut="HideTip('tt277')" class=ISymbol>Performing Backups</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/roles/controllers/settings-php.html#permission_matrix" id=link291 onMouseOver="ShowTip(event, 'tt278', 'link291')" onMouseOut="HideTip('tt278')" class=ISymbol>permission_matrix</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/permissions/models/permission_model-php.html#Permission_model" id=link292 onMouseOver="ShowTip(event, 'tt279', 'link292')" onMouseOut="HideTip('tt279')" class=ISymbol>Permission_model</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/permissions-txt.html#Permissions" id=link293 onMouseOver="ShowTip(event, 'tt280', 'link293')" onMouseOut="HideTip('tt280')" class=ISymbol>Permissions</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/permissions-txt.html#Permissions_Overview" id=link294 onMouseOver="ShowTip(event, 'tt281', 'link294')" onMouseOut="HideTip('tt281')" class=ISymbol>Permissions Overview</a></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.$perms" id=link295 onMouseOver="ShowTip(event, 'tt282', 'link295')" onMouseOut="HideTip('tt282')" class=ISymbol>perms</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/emailer/controllers/settings-php.html#Emailer_Settings_Context.preview" id=link296 onMouseOver="ShowTip(event, 'tt283', 'link296')" onMouseOut="HideTip('tt283')" class=ISymbol>preview</a>, <span class=IParent>Emailer Settings Context</span></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core/MY_Controller-php.html#Base_Controller.$previous_page" id=link297 onMouseOver="ShowTip(event, 'tt284', 'link297')" onMouseOut="HideTip('tt284')" class=ISymbol>previous_page</a>, <span class=IParent>Base_Controller</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/emailer/libraries/emailer-php.html#Emailer.process_queue" id=link298 onMouseOver="ShowTip(event, 'tt285', 'link298')" onMouseOut="HideTip('tt285')" class=ISymbol>process_queue</a>, <span class=IParent>Emailer</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/emailer-txt.html#Processing_the_Queue" id=link299 onMouseOver="ShowTip(event, 'tt286', 'link299')" onMouseOut="HideTip('tt286')" class=ISymbol>Processing the Queue</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/controllers/users-php.html#Users.profile" id=link300 onMouseOver="ShowTip(event, 'tt287', 'link300')" onMouseOut="HideTip('tt287')" class=ISymbol>profile</a>, <span class=IParent>Users</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/logs/controllers/developer-php.html#Logs_Developer_Context.purge" id=link301 onMouseOver="ShowTip(event, 'tt288', 'link301')" onMouseOut="HideTip('tt288')" class=ISymbol>purge</a>, <span class=IParent>Logs Developer Context</span></td></tr><tr><td class=IHeading><a name="Q"></a>Q</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/emailer/controllers/settings-php.html#Emailer_Settings_Context.queue" id=link302 onMouseOver="ShowTip(event, 'tt289', 'link302')" onMouseOut="HideTip('tt289')" class=ISymbol>queue</a>, <span class=IParent>Emailer Settings Context</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/emailer/libraries/emailer-php.html#Emailer.queue_email" id=link303 onMouseOver="ShowTip(event, 'tt290', 'link303')" onMouseOut="HideTip('tt290')" class=ISymbol>queue_email</a>, <span class=IParent>Emailer</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/emailer/libraries/emailer-php.html#Emailer.queue_emails" id=link304 onMouseOver="ShowTip(event, 'tt291', 'link304')" onMouseOut="HideTip('tt291')" class=ISymbol>queue_emails</a>, <span class=IParent>Emailer</span></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core_modules/emailer/libraries/emailer-php.html#Emailer.$queue_emails" id=link305 onMouseOver="ShowTip(event, 'tt292', 'link305')" onMouseOut="HideTip('tt292')" class=ISymbol>queue_emails</a>, <span class=IParent>Emailer</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/emailer-txt.html#Queuing_Emails_In_Your_Modules" id=link306 onMouseOver="ShowTip(event, 'tt293', 'link306')" onMouseOut="HideTip('tt293')" class=ISymbol>Queuing Emails In Your Modules</a></td></tr><tr><td class=IHeading><a name="R"></a>R</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#read_config" id=link307 onMouseOver="ShowTip(event, 'tt294', 'link307')" onMouseOut="HideTip('tt294')" class=ISymbol>read_config</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#read_db_config" id=link308 onMouseOver="ShowTip(event, 'tt295', 'link308')" onMouseOut="HideTip('tt295')" class=ISymbol>read_db_config</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.redirect" id=link309 onMouseOver="ShowTip(event, 'tt296', 'link309')" onMouseOut="HideTip('tt296')" class=ISymbol>redirect</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/event_hooks-txt.html#Registering_Your_Events" id=link310 onMouseOver="ShowTip(event, 'tt297', 'link310')" onMouseOut="HideTip('tt297')" class=ISymbol>Registering Your Events</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/MY_date_helper-php.html#relative_time" id=link311 onMouseOver="ShowTip(event, 'tt298', 'link311')" onMouseOut="HideTip('tt298')" class=ISymbol>relative_time</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.remove_theme_path" id=link312 onMouseOver="ShowTip(event, 'tt299', 'link312')" onMouseOut="HideTip('tt299')" class=ISymbol>remove_theme_path</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.render" id=link313 onMouseOver="ShowTip(event, 'tt300', 'link313')" onMouseOut="HideTip('tt300')" class=ISymbol>render</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/designers/views-txt.html#Rendering_A_View" id=link314 onMouseOver="ShowTip(event, 'tt301', 'link314')" onMouseOut="HideTip('tt301')" class=ISymbol>Rendering A View</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/designers/views-txt.html#Rendering_Module_Views" id=link315 onMouseOver="ShowTip(event, 'tt302', 'link315')" onMouseOut="HideTip('tt302')" class=ISymbol>Rendering Module Views</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/database-txt.html#Repairing_Tables" id=link316 onMouseOver="ShowTip(event, 'tt303', 'link316')" onMouseOut="HideTip('tt303')" class=ISymbol>Repairing Tables</a></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core/MY_Controller-php.html#Base_Controller.$requested_page" id=link317 onMouseOver="ShowTip(event, 'tt304', 'link317')" onMouseOut="HideTip('tt304')" class=ISymbol>requested_page</a>, <span class=IParent>Base_Controller</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/contexts-txt.html#Required_Contexts" id=link318 onMouseOver="ShowTip(event, 'tt305', 'link318')" onMouseOut="HideTip('tt305')" class=ISymbol>Required Contexts</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/designers/blocks-txt.html#Reserving_Block_Space" id=link319 onMouseOver="ShowTip(event, 'tt306', 'link319')" onMouseOut="HideTip('tt306')" class=ISymbol>Reserving Block Space</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/controllers/users-php.html#Users.reset_password" id=link320 onMouseOver="ShowTip(event, 'tt307', 'link320')" onMouseOut="HideTip('tt307')" class=ISymbol>reset_password</a>, <span class=IParent>Users</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.restrict" id=link321 onMouseOver="ShowTip(event, 'tt308', 'link321')" onMouseOut="HideTip('tt308')" class=ISymbol>restrict</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core_modules/install/controllers/install-php.html#Install.$reverse_writable_folders" id=link322 onMouseOver="ShowTip(event, 'tt309', 'link322')" onMouseOut="HideTip('tt309')" class=ISymbol>reverse_writable_folders</a>, <span class=IParent>Install</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/install/controllers/install-php.html#Install.rewrite_check" id=link323 onMouseOver="ShowTip(event, 'tt310', 'link323')" onMouseOut="HideTip('tt310')" class=ISymbol>rewrite_check</a>, <span class=IParent>Install</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.role_id" id=link324 onMouseOver="ShowTip(event, 'tt311', 'link324')" onMouseOut="HideTip('tt311')" class=ISymbol>role_id</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/roles/models/role_model-php.html#Role_model" id=link325 onMouseOver="ShowTip(event, 'tt312', 'link325')" onMouseOut="HideTip('tt312')" class=ISymbol>Role_model</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.role_name_by_id" id=link326 onMouseOver="ShowTip(event, 'tt313', 'link326')" onMouseOut="HideTip('tt313')" class=ISymbol>role_name_by_id</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/roles/models/role_permission_model-php.html#Role_permission_model" id=link327 onMouseOver="ShowTip(event, 'tt314', 'link327')" onMouseOut="HideTip('tt314')" class=ISymbol>Role_permission_model</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/roles-txt.html#Roles" id=link328 onMouseOver="ShowTip(event, 'tt315', 'link328')" onMouseOut="HideTip('tt315')" class=ISymbol>Roles</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/roles-txt.html#Roles_Overview" id=link329 onMouseOver="ShowTip(event, 'tt316', 'link329')" onMouseOut="HideTip('tt316')" class=ISymbol>Roles Overview</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>Running Tests</span><div class=ISubIndex><a href="../files2/core_modules/tester-txt.html#Running_Tests" id=link330 onMouseOver="ShowTip(event, 'tt317', 'link330')" onMouseOut="HideTip('tt317')" class=IFile>core_modules/<wbr>tester.txt</a><a href="../files2/general_topics/unit_testing-txt.html#Running_Tests" id=link331 onMouseOver="ShowTip(event, 'tt317', 'link331')" onMouseOut="HideTip('tt317')" class=IFile>general_topics/<wbr>unit_testing.txt</a></div></td></tr></table>
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt244"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function matrix_update()</td></tr></table></blockquote>Updates the role_permissions table.</div></div><div class=CToolTip id="tt245"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private $menu</td></tr></table></blockquote>Stores the organized menu actions.</div></div><div class=CToolTip id="tt246"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function message(</td><td class=PParameter nowrap>$message</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$type</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'information'</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Displays a status message (small success/error messages). </div></div><div class=CToolTip id="tt247"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>protected static $message</td></tr></table></blockquote>Holds a simple array to store the status Message that gets displayed using the message() function.</div></div><div class=CToolTip id="tt248"><div class=CClass>All migrations should implement this, forces up() and down() and gives access to the CI super-global.</div></div><div class=CToolTip id="tt249"><div class=CGeneric>Bonfire supports three separate spheres of migrations: Core, Application, and Module.</div></div><div class=CToolTip id="tt250"><div class=CGeneric>Unlike the migrations that CodeIgniter provides, Bonfire&rsquo;s migrations support two different types of migration files, allowing you to work the way that works best for you.</div></div><div class=CToolTip id="tt251"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public $migration_type</td></tr></table></blockquote>The type of migration being ran, either &lsquo;forge&rsquo; or &lsquo;sql&rsquo;.</div></div><div class=CToolTip id="tt252"><div class=CClass>Migrations provide a simple method to version the contents of your database, and make those changes easily distributable to other developers in different server environments.</div></div><div class=CToolTip id="tt253"><div class=CClass>Utility main controller.</div></div><div class=CToolTip id="tt254"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>protected $modified_field</td></tr></table></blockquote>Field name to use to the modified time column in the DB table.</div></div><div class=CToolTip id="tt255"><div class=CGeneric>While not necessary, modules can have a <u>config.php</u> file to enhance the way their module is displayed throughout the system. </div></div><div class=CToolTip id="tt256"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function module_config(</td><td class=PParameter nowrap>$module_name</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$return_full</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the &lsquo;module_config&rsquo; array from a modules config/config.php file.</div></div><div class=CToolTip id="tt257"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function module_controller_exists(</td><td class=PParameter nowrap>$controller</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$module</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Determines whether a controller exists for a module.</div></div><div class=CToolTip id="tt258"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function module_file_path(</td><td class=PParameter nowrap>$module</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$folder</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$file</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Finds the path to a module&rsquo;s file.</div></div><div class=CToolTip id="tt259"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function module_files(</td><td class=PParameter nowrap>$module_name</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$module_folder</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$exclude_core</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns an associative array of files within one or more modules.</div></div><div class=CToolTip id="tt260"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function module_folders()</td></tr></table></blockquote>Returns an array of the folders that modules are allowed to be stored in. </div></div><div class=CToolTip id="tt261"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function module_js(</td><td class=PParameter nowrap>$list</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Renders out links for the module&rsquo;s external javascript files.</div></div><div class=CToolTip id="tt262"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function module_list(</td><td class=PParameter nowrap>$exclude_core</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a list of all modules in the system.</div></div><div class=CToolTip id="tt263"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>protected static $module_scripts</td></tr></table></blockquote>An array of module js code used to combined into one js file to be called at the end of the page.</div></div><div class=CToolTip id="tt264"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private static $module_styles</td></tr></table></blockquote>An array of module css files to be placed at the beginning of the file.</div></div><div class=CToolTip id="tt265"><div class=CGeneric>Modules are collections of MVC triads that contain functionality limited to one specific area, like Pages or Database Tools. </div></div><div class=CToolTip id="tt266"><div class=CSection>For some sites, you may want to move the <u>application folder</u> to a different location. </div></div><div class=CToolTip id="tt267"><div class=CFile>Includes additional date-related functions helpful in Bonfire development.</div></div><div class=CToolTip id="tt268"><div class=CClass>This simply extends BF_Model for backwards compatibility, and to provide a placeholder class that your project can customize extend as needed.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt269"><div class=CGeneric>Permissions are named based on three parts</div></div><div class=CToolTip id="tt270"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function num_login_attempts(</td><td class=PParameter nowrap>$login</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get number of attempts to login occured from given IP-address and/or login</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt271"><div class=CGeneric>A common scenario on web sites is to have a common theme used across all of the public-facing pages, with variations for the home page, blog pages, and maybe even any store pages.</div></div><div class=CToolTip id="tt272"><div class=CGeneric>It might be that your server environment does not support the PATH_INFO variable needed to serve search-engine friendly pages. </div></div><div class=CToolTip id="tt273"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function order_by(</td><td class=PParameter nowrap>$field</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$order</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'asc'</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Inserts a chainable order_by method from either a string or an array of field/order combinations. </div></div><div class=CToolTip id="tt274"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>protected static $orig_view_path</td></tr></table></blockquote>Stores CI&rsquo;s default view path.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt275"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function parse_views(</td><td class=PParameter nowrap>$parse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set whether or not the views will be passed through CI&rsquo;s parser.</div></div><div class=CToolTip id="tt276"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static $parse_views</td></tr></table></blockquote>If true, CodeIgniter&rsquo;s Template Parser will be used to parse the view. </div></div><div class=CToolTip id="tt277"><div class=CGeneric>To create backups of all or part of your database, navigate to the Developer / Database / Maintenance page. </div></div><div class=CToolTip id="tt278"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function permission_matrix()</td></tr></table></blockquote>Creates a real-time modifiable summary table of all roles and permissions</div></div><div class=CToolTip id="tt279"><div class=CClass>Provides access and utility methods for handling permission storage in the database.</div></div><div class=CToolTip id="tt280"><div class=CSection>The Permissions module allows you to easily manage the permissions used throughout your application. </div></div><div class=CToolTip id="tt281"><div class=CGeneric>Permissions in Bonfire are named based on a simple, yet flexible, scheme that allows you to always know exactly the permission you are using and what module it belongs to.</div></div><div class=CToolTip id="tt282"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private $perms</td></tr></table></blockquote>Stores permissions by role so we don&rsquo;t have to scour the database more than once.</div></div><div class=CToolTip id="tt283"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function preview(</td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Displays a preview of the email as stored in the database.</div></div><div class=CToolTip id="tt284"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>protected $previous_page</td></tr></table></blockquote>Stores the previously viewed page&rsquo;s complete URL.</div></div><div class=CToolTip id="tt285"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function process_queue(</td><td class=PParameter nowrap>$limit</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>33</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Process the email queue in chunks.</div></div><div class=CToolTip id="tt286"><div class=CGeneric>Once emails have been queued, they need to be sent somehow. </div></div><div class=CToolTip id="tt287"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function profile()</td></tr></table></blockquote>Allows a user to edit their own profileinformation.</div></div><div class=CToolTip id="tt288"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function purge()</td></tr></table></blockquote>Deletes all existing log files.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt289"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function queue()</td></tr></table></blockquote>Displays all of the emails currently in the queue to be sent.</div></div><div class=CToolTip id="tt290"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>private function queue_email(</td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$to</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$from,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$subject</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$message</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$alt_message</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Add the email to the database to be sent out during a cron job.</div></div><div class=CToolTip id="tt291"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function queue_emails(</td><td class=PParameter nowrap>$queue</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Specifies whether to queue emails in the send() method.</div></div><div class=CToolTip id="tt292"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public $queue_emails</td></tr></table></blockquote>Whether to send emails immediately or queue them by default.</div></div><div class=CToolTip id="tt293"><div class=CGeneric>The best thing to do when building your site is to use the Emailer library in place of CodeIgniter&rsquo;s Email class. </div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt294"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function read_config(</td><td class=PParameter nowrap>$file,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$fail_gracefully</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>TRUE</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns an array of configuration settings from a single config file.</div></div><div class=CToolTip id="tt295"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function read_db_config(</td><td class=PParameter nowrap>$environment</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$new_db</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> NULL,</td></tr><tr><td></td><td class=PParameter nowrap>$fail_gracefully</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> TRUE</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Retrieves the config/database.php file settings. </div></div><div class=CToolTip id="tt296"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function redirect(</td><td class=PParameter nowrap>$url</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a javascript solution for page redirection. </div></div><div class=CToolTip id="tt297"><div class=CGeneric>In order for events to be ran, they must first be registered in the config/events.php file, by adding your script&rsquo;s information to the array. </div></div><div class=CToolTip id="tt298"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>if (</td><td class=PParameter nowrap>!function_exists('relative_time')</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Takes a UNIX timestamp and returns a string representing how long ago that date was, like &ldquo;moments ago&rdquo;, &ldquo;2 weeks ago&rdquo;, etc.</div></div><div class=CToolTip id="tt299"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function remove_theme_path(</td><td class=PParameter nowrap>$path</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt300"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public static function render(</td><td class=PParameter nowrap>$layout</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Renders out the specified layout, which starts the process of rendering the page content. </div></div><div class=CToolTip id="tt301"><div class=CGeneric>You can render a view from within any controller&rsquo;s method, by simply calling...</div></div><div class=CToolTip id="tt302"><div class=CGeneric>Since most of your work is going to be in a module, Bonfire will look within the module&rsquo;s view file before looking in the application&rsquo;s view folder. </div></div><div class=CToolTip id="tt303"><div class=CGeneric>Repairing database tables will attempt to recover your data in the chance that your tables become corrupted. </div></div><div class=CToolTip id="tt304"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>protected $requested_page</td></tr></table></blockquote>Stores the page requested. </div></div><div class=CToolTip id="tt305"><div class=CGeneric>Bonfire requires only two contexts to exist, and will create them if they don&rsquo;t. </div></div><div class=CToolTip id="tt306"><div class=CGeneric>In your layout file, you would reserve, say a sidebar, room by calling...</div></div><div class=CToolTip id="tt307"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function reset_password(</td><td class=PParameter nowrap>$email</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$code</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Allows the user to create a new password for their account. </div></div><div class=CToolTip id="tt308"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function restrict(</td><td class=PParameter nowrap>$permission</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$uri</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Checks that a user is logged in (and, optionally of the correct role) and, if not, send them to the login screen.</div></div><div class=CToolTip id="tt309"><div class=CVariable>An array of folders the installer can make unwriteable after installation.</div></div><div class=CToolTip id="tt310"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private function rewrite_check()</td></tr></table></blockquote>Verifies that mod_rewrite is enabled as a PHP extension.</div></div><div class=CToolTip id="tt311"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function role_id()</td></tr></table></blockquote>Retrieves the role_id from the current session.</div></div><div class=CToolTip id="tt312"><div class=CClass>Provides access and utility methods for handling role storage in the database.</div></div><div class=CToolTip id="tt313"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function role_name_by_id(</td><td class=PParameter nowrap>$role_id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Retrieves the role_name for the request role.</div></div><div class=CToolTip id="tt314"><div class=CClass>Provides access and utility methods for handling permission storage in the database.</div></div><div class=CToolTip id="tt315"><div class=CSection>The Roles Module provides a simple, yet flexible Role-Based Access Control (RBAC) system for your applications. </div></div><div class=CToolTip id="tt316"><div class=CGeneric>Roles allow you to segregate which groups of users can access which parts of your site, or what actions they can perform once they are there. </div></div><div class=CToolTip id="tt317"><div class=CGeneric>Tests are ran through the Admin UI by navigating to Developer / Tester. </div></div><!--END_ND_TOOLTIPS-->

</div><!--Index-->


<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MTitle>Bonfire<div class=MSubTitle>Faster CodeIgniter Development</div></div><div class=MEntry><div class=MFile><a href="../files2/welcome-txt.html">Welcome to Bonfire</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Basic Info</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../files2/basic_info/requirements-txt.html">Server Requirements</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/license-txt.html">License Agreement</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/changelog-txt.html">Changelog</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/credits-txt.html">Credits</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Installation</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../files2/installation/installing-txt.html">Fresh Installation</a></div></div><div class=MEntry><div class=MFile><a href="../files2/installation/troubleshooting-txt.html">Troubleshooting Guide</a></div></div><div class=MEntry><div class=MFile><a href="../files2/installation/upgrading-txt.html">Upgrading</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Introduction</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../files2/introduction/getting_started-txt.html">Getting Started</a></div></div><div class=MEntry><div class=MFile><a href="../files2/introduction/overview-txt.html">Bonfire Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/introduction/concepts-txt.html">Important Concepts</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">General Topics</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../files2/general_topics/ajax-txt.html">AJAX in Bonfire</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/controllers-txt.html">Base Controllers</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/contexts-txt.html">Contexts Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/module_overview-txt.html">Modules Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/application_folder-txt.html">Moving the Application Folder</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/site_areas-txt.html">Site Areas</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/event_hooks-txt.html">System Events</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/auth_notes-txt.html">Understanding Authentication</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/unit_testing-txt.html">Unit Testing</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Core Modules</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="../files2/core_modules/activities-txt.html">Activities</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/database-txt.html">Database</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/emailer-txt.html">Emailer</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/logs-txt.html">Logs</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/migrations-txt.html">Migrations</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/permissions-txt.html">Permissions</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/roles-txt.html">Roles</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/tester-txt.html">Tester</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/ui-txt.html">UI</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Designers</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="../files2/designers/introduction-txt.html">Designer Introduction</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/views-txt.html">Views and Layouts</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/blocks-txt.html">Blocks</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/data-txt.html">Dynamic Data</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/flash-txt.html">Flash Messages</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/ajax-txt.html">Handling AJAX</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/utilities-txt.html">Template Utility Functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">Tutorials</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="../files3/todo-txt.html">ToDo Module</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Class Reference</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">Core Overrides</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MFile><a href="../files/core/MY_Model-php.html">BF_Model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core/MY_Controller-php.html">Controllers</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">Models</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/models/role_model-php.html">Role_model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/models/role_permission_model-php.html">Role_permission_model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/permissions/models/permission_model-php.html">Permission_model</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">Helpers</a><div class=MGroupContent id=MGroupContent10><div class=MEntry><div class=MFile><a href="../files/helpers/address_helper-php.html">Address Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/application_helper-php.html">Application Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/MY_array_helper-php.html">Array Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/config_file_helper-php.html">Config File Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/MY_date_helper-php.html">MY_date_helper</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">Libraries</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="../files/libraries/assets-php.html">Assets</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/Console-php.html">Console</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/events-php.html">Events Class</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/template-php.html">Template</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent14')">Core Modules</a><div class=MGroupContent id=MGroupContent14><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/models/activity_model-php.html">Activities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">Emailer</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="../files/core_modules/emailer/libraries/emailer-php.html">Emailer Library</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/emailer/controllers/settings-php.html">Emailer Settings Context</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/install/controllers/install-php.html">Install</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/logs/controllers/developer-php.html">Logs Developer Context</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/migrations/libraries/Migrations-php.html">Migrations</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent13')">Users</a><div class=MGroupContent id=MGroupContent13><div class=MEntry><div class=MFile><a href="../files/core_modules/users/libraries/auth-php.html">Auth Library</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/users/controllers/users-php.html">Users Controller</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/users/models/user_model-php.html">User Model</a></div></div></div></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Bonfire</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Activities</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/controllers/activities-php.html">Activities</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/controllers/reports-php.html">Activities Reports Context</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/assets/js/jquery-dataTables-min-js.html">jquery.<wbr>dataTables.<wbr>min.js</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/views/reports/datatable_js-php.html">views/<wbr>reports/<wbr>datatable_js.php</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/modulebuilder/views/files/controller-php.html">modulebuilder/.../files/<wbr>controller.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/modulebuilder/controllers/developer-php.html">modulebuilder/<wbr>controllers/<wbr>developer.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/controllers/settings-php.html">roles/<wbr>controllers/<wbr>settings.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/subnav/controllers/subnav-php.html">subnav/<wbr>controllers/<wbr>subnav.php</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent18')">Index</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MIndex id=MSelected>Everything</div></div><div class=MEntry><div class=MIndex><a href="Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="Files.html">Files</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([18], 19);// --></script></div><!--Menu-->


<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>